globe with meridians Language: Deutsch · English

hammer and wrench Maintenance mode

Lock the system for maintenance – activate via web client or REST, query status and end it.

HOW-TO ADMINISTRATOR UPDATED: JUL 2026 APPLIES TO NUCLOS 4.2026.X

On this page

The maintenance mode puts the system into a state without disruptive transactions – ideal before nuclet import/export. When activated, all users except the starting super user are logged out, job control is paused and file imports are blocked. Only the starting super user stays logged in.

Via the web client

A super user selects the maintenance mode working environment and clicks activate maintenance mode. After ending it, jobs and imports resume and users can log in again.

Via the REST interface

Most calls require a super user login (examples using curl).

Login

sessionId=`curl http://localhost:8080/nuclos-war/rest/login -X POST -H "Content-Type: application/json" -d '{"username":"nuclos", "password":"", "locale":"en-EN"}'`
 
# Nuclos 4.3 - 4.5:
sessionId=`curl http://localhost:8080/nuclos-war/rest -X POST -H "Accept:application/json" -H "Content-Type: application/json" -d '{"username":"nuclos", "password":""}' | awk -v FS="\"" '{ print $4  }'`
# Für alle folgenden Aufrufe muss die "sessionId" als Request-Parameter übergeben werden.
 
# ab Nuclos 4.6:
curl --cookie-jar cookies.txt http://localhost:8080/nuclos-war/rest -X POST -H "Content-Type: application/json" -d '{"username":"'nuclos'", "password":"''"}';
# Anstatt des "sessionId"-Request-Parameters wird das JSESSIONID Cookie über den Cookiestore verwendet.

Start maintenance mode

# bis 4.28
curl --cookie cookies.txt http://localhost:8080/nuclos-war/rest/maintenance/start


# ab 4.29
curl --cookie cookies.txt -X PUT "http://localhost:2019/nuclos-war/rest/maintenance/mode" -d on
curl --cookie cookies.txt -X PUT "http://localhost:2019/nuclos-war/rest/maintenance/mode?force=true" -d on # es wird nicht darauf gewartet, bis alle Clients abgemeldet sind

Query status

curl --cookie cookies.txt http://localhost:8080/nuclos-war/rest/maintenance/mode

Possible values: off (inactive), initialized (starting), on (active).

End maintenance mode

# bis 4.28
curl --cookie cookies.txt http://localhost:8080/nuclos-war/rest/maintenance/end

# ab 4.29
curl  --cookie cookies.txt -X PUT "http://localhost:2019/nuclos-war/rest/maintenance/mode" -d off

Logout

curl http://localhost:8080/nuclos-war/rest/logout?sessionid=$sessionId
 
# Nuclos 4.3 - 4.5:
curl http://localhost:8080/nuclos-war/rest?sessionId=$sessionid -X DELETE
 
# ab Nuclos 4.6:
curl --cookie-jar cookies.txt http://localhost:8080/nuclos-war/rest -X DELETE

Related pages

gear Management Console


Console.

Open →

gear Cluster service


Cluster.

Open →

  • Keine Stichwörter